Field Name | Type (max length) |
Required MandatoryOptional |
Description |
---|---|---|---|
MerchantReference | String[20] | M | This is the unique value that is used by the Merchant to identify the transaction on his system (e.g. Their quote number, product, and order or invoice number). |
RequestIdentifier | String[20] | O | This is a unique identifier that you as the Merchant use to identify this payment broker request (e.g. Typically use a UUID). |
TransactionType ^ | String[2] | M | This will indicate the type of transaction requested. Defaults to "01". Valid values:
|
SalesType ^ | String[2] | O | Indicates the type of telco goods being purchased: Valid values:
|
TransactionCompletedURL ^ | String(256) | O | Redirect URL for successful transaction. Overrides an existing URL for the merchant, if a value is passed. |
RedirectURL ^ | String(256) | O | Redirect URL for an unsuccessful transaction. Overrides an existing URL for the merchant, if a value is passed |
Currency ^ | String(3) | M | Country currency. Supply the 3 character ISO currency code. Defaults to "ZAR". |
SupplierID | String | M |
This is the VPG assigned merchant identifier. The SupplierID field value will be submitted as SupplierAlias which are synonymous. e.g. "VC Upfront Payments" Will be provided by VFS after merchant on–boarding. |
Product | Object | M | See Table 10. Connect.Create.Form.Products Object Fields |
DeliveryAmount | Decimal | O | Delivery Cost for Basket Total. Only used if any Product has a Delivery requirement. |
Webhooks | Object | M |
This is the template–driven body for the post–back to the merchants system after the call to the Payment Gateway. It includes the URL to post-back to and the data to be contained in the template. This will allow the structure of your end–point to change without development being required. See Table 11. Connect.Create.Form.WebHooks Object Fields |
Metadata ^ | String | O |
Additional JSON information to be passed by the merchant as and when required. Must be Base64 encoded. Default to NULL. Engage with the VFS for further use on this parameter. |
EncryptionJSON | String | O | For Internal Use only |
EncryptionType | String | O | For Internal Use only |
EncryptionSalt | String | O | For Internal Use only |
EncryptionIV | String | O | For Internal Use only |
EncryptionIterations | String | O | For Internal Use only |